home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / adodb / drivers / adodb-ldap.inc.php < prev    next >
PHP Script  |  2005-05-17  |  12KB  |  396 lines
  1. <?php
  2. /*
  3.   V4.63 17 May 2005  (c) 2000-2005 John Lim (jlim#natsoft.com.my). All rights reserved.
  4.    Released under both BSD license and Lesser GPL library license. 
  5.   Whenever there is any discrepancy between the two licenses, 
  6.   the BSD license will take precedence.
  7.   Set tabs to 8.
  8.   
  9.   Revision 1: (02/25/2005) Updated codebase to include the _inject_bind_options function. This allows
  10.   users to access the options in the ldap_set_option function appropriately. Most importantly
  11.   LDAP Version 3 is now supported. See the examples for more information. Also fixed some minor
  12.   bugs that surfaced when PHP error levels were set high.
  13.   
  14.   Joshua Eldridge (joshuae74#hotmail.com)
  15. */ 
  16.  
  17. // security - hide paths
  18. if (!defined('ADODB_DIR')) die();
  19.  
  20. if (!defined('LDAP_ASSOC')) {
  21.      define('LDAP_ASSOC',ADODB_FETCH_ASSOC);
  22.      define('LDAP_NUM',ADODB_FETCH_NUM);
  23.      define('LDAP_BOTH',ADODB_FETCH_BOTH);
  24. }
  25.  
  26. class ADODB_ldap extends ADOConnection {
  27.     var $databaseType = 'ldap';
  28.     var $dataProvider = 'ldap';
  29.     
  30.     # Connection information
  31.     var $username = false;
  32.     var $password = false;
  33.     
  34.     # Used during searches
  35.     var $filter;
  36.     var $dn;
  37.     var $version;
  38.  
  39.     # Options configuration information
  40.     var $LDAP_CONNECT_OPTIONS;
  41.  
  42.     function ADODB_ldap() 
  43.     {        
  44.  
  45.     }
  46.           
  47.     // returns true or false
  48.     
  49.     function _connect( $host, $username, $password, $ldapbase )
  50.     {
  51.  
  52.     global $LDAP_CONNECT_OPTIONS;
  53.  
  54.        if ( !function_exists( 'ldap_connect' ) ) return null;
  55.        
  56.        $conn_info = array( $host );
  57.        
  58.        if ( strstr( $host, ':' ) ) {
  59.            $conn_info = split( ':', $host );
  60.        } 
  61.  
  62.        $this->_connectionID = ldap_connect( $conn_info[0], $conn_info[1] ) 
  63.            or die( 'Could not connect to ' . $this->_connectionID );
  64.  
  65.        if( count( $LDAP_CONNECT_OPTIONS ) > 0 ) {
  66.             $this->_inject_bind_options( $LDAP_CONNECT_OPTIONS );
  67.         }
  68.  
  69.        if ($username && $password) {
  70.            $bind = ldap_bind( $this->_connectionID, $username, $password ) 
  71.                or die( 'Could not bind to ' . $this->_connectionID . ' with $username & $password');
  72.        } else {
  73.            $bind = ldap_bind( $this->_connectionID ) 
  74.                or die( 'Could not bind anonymously to ' . $this->_connectionID );
  75.        }
  76.        $this->database = $ldapbase;
  77.        return $this->_connectionID;
  78.     }
  79.     
  80. /*
  81.     Valid Domain Values for LDAP Options:
  82.  
  83.     LDAP_OPT_DEREF (integer)
  84.     LDAP_OPT_SIZELIMIT (integer)
  85.     LDAP_OPT_TIMELIMIT (integer)
  86.     LDAP_OPT_PROTOCOL_VERSION (integer)
  87.     LDAP_OPT_ERROR_NUMBER (integer)
  88.     LDAP_OPT_REFERRALS (boolean)
  89.     LDAP_OPT_RESTART (boolean)
  90.     LDAP_OPT_HOST_NAME (string)
  91.     LDAP_OPT_ERROR_STRING (string)
  92.     LDAP_OPT_MATCHED_DN (string)
  93.     LDAP_OPT_SERVER_CONTROLS (array)
  94.     LDAP_OPT_CLIENT_CONTROLS (array)
  95.  
  96.     Make sure to set this BEFORE calling Connect()
  97.  
  98.     Example:
  99.  
  100.     $LDAP_CONNECT_OPTIONS = Array(
  101.         Array (
  102.             "OPTION_NAME"=>LDAP_OPT_DEREF,
  103.             "OPTION_VALUE"=>2
  104.         ),
  105.         Array (
  106.             "OPTION_NAME"=>LDAP_OPT_SIZELIMIT,
  107.             "OPTION_VALUE"=>100
  108.         ),
  109.         Array (
  110.             "OPTION_NAME"=>LDAP_OPT_TIMELIMIT,
  111.             "OPTION_VALUE"=>30
  112.         ),
  113.         Array (
  114.             "OPTION_NAME"=>LDAP_OPT_PROTOCOL_VERSION,
  115.             "OPTION_VALUE"=>3
  116.         ),
  117.         Array (
  118.             "OPTION_NAME"=>LDAP_OPT_ERROR_NUMBER,
  119.             "OPTION_VALUE"=>13
  120.         ),
  121.         Array (
  122.             "OPTION_NAME"=>LDAP_OPT_REFERRALS,
  123.             "OPTION_VALUE"=>FALSE
  124.         ),
  125.         Array (
  126.             "OPTION_NAME"=>LDAP_OPT_RESTART,
  127.             "OPTION_VALUE"=>FALSE
  128.         )
  129.     );
  130. */
  131.  
  132.     function _inject_bind_options( $options ) {
  133.         foreach( $options as $option ) {
  134.             ldap_set_option( $this->_connectionID, $option["OPTION_NAME"], $option["OPTION_VALUE"] )
  135.                 or die( "Unable to set server option: " . $option["OPTION_NAME"] );
  136.         }
  137.     }
  138.     
  139.     /* returns _queryID or false */
  140.     function _query($sql,$inputarr)
  141.     {
  142.        $rs = ldap_search( $this->_connectionID, $this->database, $sql );
  143.        return $rs; 
  144.         
  145.     }
  146.  
  147.     /* closes the LDAP connection */
  148.     function _close()
  149.     {
  150.         @ldap_close( $this->_connectionID );
  151.         $this->_connectionID = false;
  152.     }
  153.     
  154.     function SelectDB($db) {
  155.         $this->database = $db;
  156.         return true;
  157.     } // SelectDB
  158.  
  159.     function ServerInfo()
  160.     {
  161.         if( !empty( $this->version ) ) return $this->version;
  162.         $version = array();
  163.         /*
  164.         Determines how aliases are handled during search. 
  165.         LDAP_DEREF_NEVER (0x00)
  166.         LDAP_DEREF_SEARCHING (0x01)
  167.         LDAP_DEREF_FINDING (0x02)
  168.         LDAP_DEREF_ALWAYS (0x03)
  169.         The LDAP_DEREF_SEARCHING value means aliases are dereferenced during the search but 
  170.         not when locating the base object of the search. The LDAP_DEREF_FINDING value means 
  171.         aliases are dereferenced when locating the base object but not during the search.  
  172.         Default: LDAP_DEREF_NEVER
  173.         */
  174.         ldap_get_option( $this->_connectionID, LDAP_OPT_DEREF, $version['LDAP_OPT_DEREF'] ) ;
  175.         switch ( $version['LDAP_OPT_DEREF'] ) {
  176.           case 0:
  177.             $version['LDAP_OPT_DEREF'] = 'LDAP_DEREF_NEVER';
  178.           case 1:
  179.             $version['LDAP_OPT_DEREF'] = 'LDAP_DEREF_SEARCHING';
  180.           case 2:
  181.             $version['LDAP_OPT_DEREF'] = 'LDAP_DEREF_FINDING';
  182.           case 3:
  183.             $version['LDAP_OPT_DEREF'] = 'LDAP_DEREF_ALWAYS';
  184.         }
  185.         
  186.         /* 
  187.         A limit on the number of entries to return from a search. 
  188.         LDAP_NO_LIMIT (0) means no limit.
  189.         Default: LDAP_NO_LIMIT
  190.         */
  191.         ldap_get_option( $this->_connectionID, LDAP_OPT_SIZELIMIT, $version['LDAP_OPT_SIZELIMIT'] );
  192.         if ( $version['LDAP_OPT_SIZELIMIT'] == 0 ) {
  193.            $version['LDAP_OPT_SIZELIMIT'] = 'LDAP_NO_LIMIT';
  194.         }
  195.         
  196.         /*
  197.         A limit on the number of seconds to spend on a search. 
  198.         LDAP_NO_LIMIT (0) means no limit.
  199.         Default: LDAP_NO_LIMIT
  200.         */
  201.         ldap_get_option( $this->_connectionID, LDAP_OPT_TIMELIMIT, $version['LDAP_OPT_TIMELIMIT'] );
  202.         if ( $version['LDAP_OPT_TIMELIMIT'] == 0 ) {
  203.            $version['LDAP_OPT_TIMELIMIT'] = 'LDAP_NO_LIMIT';
  204.         }
  205.         
  206.         /*
  207.         Determines whether the LDAP library automatically follows referrals returned by LDAP servers or not. 
  208.         LDAP_OPT_ON
  209.         LDAP_OPT_OFF
  210.         Default: ON
  211.         */
  212.         ldap_get_option( $this->_connectionID, LDAP_OPT_REFERRALS, $version['LDAP_OPT_REFERRALS'] );
  213.         if ( $version['LDAP_OPT_REFERRALS'] == 0 ) {
  214.            $version['LDAP_OPT_REFERRALS'] = 'LDAP_OPT_OFF';
  215.         } else {
  216.            $version['LDAP_OPT_REFERRALS'] = 'LDAP_OPT_ON';
  217.         
  218.         }
  219.         /*
  220.         Determines whether LDAP I/O operations are automatically restarted if they abort prematurely. 
  221.         LDAP_OPT_ON
  222.         LDAP_OPT_OFF
  223.         Default: OFF
  224.         */
  225.         ldap_get_option( $this->_connectionID, LDAP_OPT_RESTART, $version['LDAP_OPT_RESTART'] );
  226.         if ( $version['LDAP_OPT_RESTART'] == 0 ) {
  227.            $version['LDAP_OPT_RESTART'] = 'LDAP_OPT_OFF';
  228.         } else {
  229.            $version['LDAP_OPT_RESTART'] = 'LDAP_OPT_ON';
  230.         
  231.         }
  232.         /*
  233.         This option indicates the version of the LDAP protocol used when communicating with the primary LDAP server.
  234.         LDAP_VERSION2 (2)
  235.         LDAP_VERSION3 (3)
  236.         Default: LDAP_VERSION2 (2)
  237.         */
  238.         ldap_get_option( $this->_connectionID, LDAP_OPT_PROTOCOL_VERSION, $version['LDAP_OPT_PROTOCOL_VERSION'] );
  239.         if ( $version['LDAP_OPT_PROTOCOL_VERSION'] == 2 ) {
  240.            $version['LDAP_OPT_PROTOCOL_VERSION'] = 'LDAP_VERSION2';
  241.         } else {
  242.            $version['LDAP_OPT_PROTOCOL_VERSION'] = 'LDAP_VERSION3';
  243.         
  244.         }
  245.         /* The host name (or list of hosts) for the primary LDAP server. */
  246.         ldap_get_option( $this->_connectionID, LDAP_OPT_HOST_NAME, $version['LDAP_OPT_HOST_NAME'] ); 
  247.         ldap_get_option( $this->_connectionID, LDAP_OPT_ERROR_NUMBER, $version['LDAP_OPT_ERROR_NUMBER'] ); 
  248.         ldap_get_option( $this->_connectionID, LDAP_OPT_ERROR_STRING, $version['LDAP_OPT_ERROR_STRING'] ); 
  249.         ldap_get_option( $this->_connectionID, LDAP_OPT_MATCHED_DN, $version['LDAP_OPT_MATCHED_DN'] ); 
  250.         
  251.         return $this->version = $version;
  252.     
  253.     }
  254. }
  255.     
  256. /*--------------------------------------------------------------------------------------
  257.      Class Name: Recordset
  258. --------------------------------------------------------------------------------------*/
  259.  
  260. class ADORecordSet_ldap extends ADORecordSet{    
  261.     
  262.     var $databaseType = "ldap";
  263.     var $canSeek = false;
  264.     var $_entryID; /* keeps track of the entry resource identifier */
  265.     
  266.     function ADORecordSet_ldap($queryID,$mode=false) 
  267.     {
  268.         if ($mode === false) { 
  269.             global $ADODB_FETCH_MODE;
  270.             $mode = $ADODB_FETCH_MODE;
  271.         }
  272.         switch ($mode)
  273.         {
  274.         case ADODB_FETCH_NUM: 
  275.           $this->fetchMode = LDAP_NUM; 
  276.         break;
  277.         case ADODB_FETCH_ASSOC: 
  278.           $this->fetchMode = LDAP_ASSOC; 
  279.         break;
  280.         case ADODB_FETCH_DEFAULT:
  281.         case ADODB_FETCH_BOTH: 
  282.         default:
  283.           $this->fetchMode = LDAP_BOTH; 
  284.         break;
  285.         }
  286.     
  287.         $this->ADORecordSet($queryID);    
  288.     }
  289.     
  290.     function _initrs()
  291.     {
  292.        /* 
  293.        This could be teaked to respect the $COUNTRECS directive from ADODB
  294.        It's currently being used in the _fetch() function and the
  295.        GetAssoc() function
  296.        */
  297.         $this->_numOfRows = ldap_count_entries( $this->connection->_connectionID, $this->_queryID );
  298.  
  299.     }
  300.  
  301.     /*
  302.     Return whole recordset as a multi-dimensional associative array
  303.     */
  304.     function &GetAssoc($force_array = false, $first2cols = false) 
  305.     {
  306.         $records = $this->_numOfRows;
  307.         $results = array();
  308.             for ( $i=0; $i < $records; $i++ ) {
  309.                 foreach ( $this->fields as $k=>$v ) {
  310.                     if ( is_array( $v ) ) {
  311.                         if ( $v['count'] == 1 ) {
  312.                             $results[$i][$k] = $v[0];
  313.                         } else {
  314.                             array_shift( $v );
  315.                             $results[$i][$k] = $v;
  316.                         } 
  317.                     }
  318.                 }
  319.             }
  320.         
  321.         return $results; 
  322.     }
  323.     
  324.     function &GetRowAssoc()
  325.     {
  326.         $results = array();
  327.         foreach ( $this->fields as $k=>$v ) {
  328.             if ( is_array( $v ) ) {
  329.                 if ( $v['count'] == 1 ) {
  330.                     $results[$k] = $v[0];
  331.                 } else {
  332.                     array_shift( $v );
  333.                     $results[$k] = $v;
  334.                 } 
  335.             }
  336.         }
  337.  
  338.         return $results; 
  339.     }
  340.         
  341.     function GetRowNums()
  342.     {
  343.         $results = array();
  344.         foreach ( $this->fields as $k=>$v ) {
  345.         static $i = 0;
  346.             if (is_array( $v )) {
  347.                 if ( $v['count'] == 1 ) {
  348.                     $results[$i] = $v[0];
  349.                 } else {
  350.                     array_shift( $v );
  351.                     $results[$i] = $v;
  352.                 } 
  353.             $i++;
  354.             }
  355.         }
  356.         return $results;
  357.     }
  358.     
  359.     function _fetch()
  360.     {        
  361.         if ( $this->_currentRow >= $this->_numOfRows && $this->_numOfRows >= 0 )
  362.             return false;
  363.             
  364.         if ( $this->_currentRow == 0 ) {
  365.           $this->_entryID = ldap_first_entry( $this->connection->_connectionID, $this->_queryID );
  366.         } else {
  367.           $this->_entryID = ldap_next_entry( $this->connection->_connectionID, $this->_entryID );
  368.         }
  369.         
  370.         $this->fields = ldap_get_attributes( $this->connection->_connectionID, $this->_entryID );
  371.         $this->_numOfFields = $this->fields['count'];    
  372.         switch ( $this->fetchMode ) {
  373.             
  374.             case LDAP_ASSOC:
  375.             $this->fields = $this->GetRowAssoc();
  376.             break;
  377.             
  378.             case LDAP_NUM:
  379.             $this->fields = array_merge($this->GetRowNums(),$this->GetRowAssoc());
  380.             break;
  381.             
  382.             case LDAP_BOTH:
  383.             default:
  384.             $this->fields = $this->GetRowNums();
  385.             break;
  386.         }
  387.         return ( is_array( $this->fields ) );        
  388.     }
  389.     
  390.     function _close() {
  391.         @ldap_free_result( $this->_queryID );    
  392.         $this->_queryID = false;
  393.     }
  394.     
  395. }
  396. ?>